Command Line

The Controller has a command line entry box in the Control page of its Web Interface.

By checking “Parse command line submissions as Lua Commands” (see Custom Command Line Parser), any Lua, including our API (see API v5), can be entered into this field and run during normal playback.

Alternatively, users may write their own scripts which can be used as a Custom Command Line Parse if they wish (see Lua scripts) but a standard script “commandline.lua” is available here.

IMPORTANT: Note that by default there is no command line script installed. Most installations will not require a command line and so it is inactive by default. If you wish to use the standard command line script you must use the “ Command Line Parser” section of the Web Interface section of Project Mode to select the script.

The command line syntax defined in the standard commandline.lua script has the following commands, where x,y and z represent numbers and [] indicates optional syntax:

Selections

x-y

x/y

x-y/z

where x, y and z are the fixture number, '-' selects a range and '/' combines discrete selections or ranges.

Setting intensity

x@y[%][tz]

where x is the fixture number, y is the level (either as a DMX value or as a percentage) and z is an optional time in seconds. If a time is not specified then it is treated as a snap change.

Examples:

1@127	Set intensity of fixture 1 to 127 immediately
2@50%	Set intensity of fixture 2 to 50% (127) immediately
3@100%t5.5	Set intensity of fixture 3 to 100% fading over 5.5 seconds

Setting RGB

Setting red, green and blue uses the same syntax as intensity, but replacing the @ with r for red, g for green, and b for blue.

Examples:

1r255	Set red of fixture 1 to 255 immediately
3g0	Set green of fixture 3 to 0 immediately
7b100%t2	Set blue of fixture 7 to 100% fading over 2 seconds

Note that the default values for red, green and blue are 100% (255) to give white. So to make a fixture output the colour red then you will need to set green and blue to zero.

You can also apply multiple settings to the same selection of fixtures in a single command. For example:

1-25@100%r255b255g0

Set fixtures 1 through 25 to 100% intensity, red to 255, blue to 255 and green to 0 immediately

Clearing fixture settings

xc[ty]

where x is the fixture number and y is an optional time in seconds.

Examples:

1c	Clear settings for fixture 1 immediately
5ct6.5	Clear settings for fixture 5 fading over 6.5 seconds

Clearing all fixtures settings

ca[tx]

where x is an optional time in seconds.

Examples:

ca	Clear settings for all fixtures immediately
cat10	Clear settings for all fixtures fading over 10 seconds

Multiple Commands

Multiple commands can be applied from a single command line if separated by commas.

Examples:

1@100%,1r0,1b0,1g255	Set intensity of fixture 1 to 100%, red and blue to 0 and green to 255
1ct5,4r255,4@75%t5	Clear settings for fixture 1 fading over 5 seconds, set red for fixture 4 to 255 immediately and then set intensity of fixture 4 to 75% fading over 5 seconds

Interaction with timeline playback

Settings applied from the command line are applied as if from a high priority timeline, so they will override all normal timeline programming until cleared. Fades to and from command line settings behave just like fades between timelines.